Skip to content
This repository has been archived by the owner on Apr 15, 2024. It is now read-only.

docs: document updating the EVM address for validators #617

Merged
merged 6 commits into from
Nov 29, 2023
Merged

docs: document updating the EVM address for validators #617

merged 6 commits into from
Nov 29, 2023

Conversation

rach-id
Copy link
Member

@rach-id rach-id commented Nov 25, 2023 •
edited by coderabbitai bot
Loading

Overview

Checklist

  • New and updated code has appropriate documentation
  • New and updated code has new and/or updated testing
  • Required CI checks are passing
  • Visual proof for any user facing features like CLI or documentation updates
  • Linked issues closed with keywords

Summary by CodeRabbit

  • Documentation

    • Updated the orchestrator management guide with instructions for:
      • Restarting the orchestrator.
      • Handling validator set changes.
      • Re-registering a new EVM address if the private key is lost.
      • Running multiple orchestrators on the same machine using different P2P ports.
      • Starting the orchestrator as a systemd service.

  • Bug Fixes

    • Corrected a typographical error in the README.md file regarding the installation version of Go.

@rach-id rach-id added documentation Improvements or additions to documentation orchestrator orchestrator related labels Nov 25, 2023
@rach-id rach-id self-assigned this Nov 25, 2023
@rach-id rach-id requested a review from evan-forbes as a code owner November 25, 2023 21:02
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 25, 2023 •
edited
Loading

Walkthrough

The recent updates focus on orchestrator management, particularly addressing scenarios involving the loss of a private key associated with an EVM address. It provides a method for re-registering a new EVM address and guidance on running multiple orchestrators on a single machine by using different P2P ports. Additionally, there's a minor typographical correction in the README related to the Go version number.

Changes

File Path Change Summary
docs/orchestrator.md Updated instructions for EVM address change, orchestrator restarts, validator set changes, and running a second orchestrator. Added details on setting up as a systemd service.
README.md Corrected the Go version number from "1.21" to "1.21".

🐇✨
In the realm of code, where changes abound,
A rabbit hopped in, with updates profound.
Keys lost, then found, with a new address to bind,
Orchestrators in pairs, with ports of their kind. 🌟🚀

Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • If you reply to a review comment from CodeRabbit, the bot will automatically respond.
  • To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
  • Note: Review comments are made on code diffs or files, not on the PR overview.
  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Note: For conversation with the bot, please use the review comments on code diffs or files.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

@rach-id rach-id requested a review from jcstein November 25, 2023 21:02
rach-id
rach-id commented Nov 25, 2023
View reviewed changes
docs/orchestrator.md
@@ -215,61 +215,7 @@ code: 0
codespace: ""
data: 12300A2E2F63656C65737469612E7167622E76312E4D7367526567697374657245564D41646472657373526573706F6E7365
events:
- attributes:
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[note to reviewers]
I think this is just noise in the documentation that requires readers to scroll unnecessarily to continue reading. It doesn't have any important information, so I deleted it

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

agreed

@codecov-commenter
Copy link

codecov-commenter commented Nov 25, 2023 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (33f7618) 26.13% compared to head (91bed0a) 26.13%.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main     #617   +/-   ##
=======================================
  Coverage   26.13%   26.13%           
=======================================
  Files          29       29           
  Lines        3019     3019           
=======================================
  Hits          789      789           
  Misses       2135     2135           
  Partials       95       95

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

jcstein
jcstein suggested changes Nov 27, 2023
View reviewed changes
docs/orchestrator.md
@@ -215,61 +215,7 @@ code: 0
codespace: ""
data: 12300A2E2F63656C65737469612E7167622E76312E4D7367526567697374657245564D41646472657373526573706F6E7365
events:
- attributes:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

agreed

docs/orchestrator.md Outdated Show resolved Hide resolved
docs/orchestrator.md Outdated Show resolved Hide resolved
rach-id and others added 2 commits November 27, 2023 19:23
coderabbitai[bot]
coderabbitai bot reviewed Nov 27, 2023
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between b0ff6d5 and 7c60bb5.
Files selected for processing (1)
  • docs/orchestrator.md (2 hunks)
Additional comments: 1
docs/orchestrator.md (1)
  • 244-257: The instructions for updating the EVM address, running a second orchestrator on the same machine, and setting up a systemd service are clear and well-documented. The note about validator set changes is particularly useful for understanding the expected behavior of the orchestrator.

docs/orchestrator.md Show resolved Hide resolved
@rach-id rach-id enabled auto-merge (squash) November 29, 2023 14:06
coderabbitai[bot]
coderabbitai bot reviewed Nov 29, 2023
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 7c60bb5 and 415a6d1.
Files selected for processing (1)
  • docs/orchestrator.md (2 hunks)
Additional comments: 3
docs/orchestrator.md (3)

  • 218-224: The addition of the ellipsis (...) clarifies that the command output is truncated, which addresses the previous concern about the output appearing incomplete.

  • 250-256: The new instructions for updating the EVM address and running multiple orchestrators on the same machine are clear and provide valuable guidance for validators.

  • 247-249: The summary mentions information on how to handle changes in the validator set, but there is no specific section in the provided file that addresses this. Please verify if this information is included elsewhere or if the summary needs to be updated.

@rach-id rach-id merged commit 071cba2 into celestiaorg:main Nov 29, 2023
17 checks passed
jcstein added a commit to celestiaorg/docs that referenced this pull request Dec 12, 2023
@jcstein
feat: match celestiaorg/orchestrator-relayer#617
abb5c2f
@jcstein jcstein mentioned this pull request Dec 12, 2023
Merged
5 tasks
jcstein added a commit to celestiaorg/docs that referenced this pull request Dec 15, 2023
@jcstein
feat: match celestiaorg/orchestrator-relayer#617 (#1322)
ee9fd97 
* feat: match celestiaorg/orchestrator-relayer#617

* Update nodes/blobstream-bootstrapper.md
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@jcstein jcstein jcstein approved these changes

@evan-forbes evan-forbes evan-forbes approved these changes

Assignees

@rach-id rach-id

Labels
documentation Improvements or additions to documentation orchestrator orchestrator related
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@rach-id @codecov-commenter @evan-forbes @jcstein